PingOne MFA Android SDK/com.pingidentity.pingidsdkv2/PingOne

PingOne

public class PingOne

Main class that contains public APIs.

Created by Ping Identity.

Copyright © 2023 Ping Identity.

All rights reserved.

Types

Link copied to clipboard
public interface PingOneAuthenticationCallback
Callback interface that will return AuthenticationObject.
Link copied to clipboard
public interface PingOneAuthenticationStatusCallback
Callback interface that will return authentication status as a String.
Link copied to clipboard
public interface PingOneGenerateMobilePayloadCallback
Callback interface that will notify about completion of the process of the mobile payload creation.
Link copied to clipboard
public interface PingOneGetInfoCallback
Callback interface that will notify developers about getInfo task completion.
Link copied to clipboard
public interface PingOneMigrationStatusCallback
Callback interface that will notify about migration status completion.
Link copied to clipboard
public interface PingOneNotificationCallback
Callback interface that will notify developers about processRemoteNotification task completion.
Link copied to clipboard
public interface PingOneOneTimePasscodeCallback
Callback interface that will return One time passcode object.
Link copied to clipboard
public interface PingOnePairingObjectCallback
Callback interface that will notify developers about processIdToken task completion PairingObject will be returned if process completed successfully.
Link copied to clipboard
public interface PingOneSDKCallback
Callback interface that will notify developers about asynchronous task completion.
Link copied to clipboard
public interface PingOneSDKPairingCallback implements PingOne.PingOneSDKCallback
Callback interface that will notify developers about pairing task completion.
Link copied to clipboard
public interface PingOneSendLogsCallback
Callback interface that will notify developers about sendLogs task completion.
Link copied to clipboard
public interface PingOneSetDeviceTokenCallback
Callback interface that will notify developers about setDeviceToken task completion.
Link copied to clipboard

Functions

Link copied to clipboard
public static void allowPushNotifications(Context context, boolean allowPush)
Method that will notify the server not to send push messages to this device.
Link copied to clipboard
public static void authenticate(Context context, String authCode, PingOne.PingOneAuthenticationCallback callback)
Method that will try to authenticate with given authCode String value.
Link copied to clipboard
public static void configure(@NonNull() Context context, @NonNull() PingOneGeo geo, @NonNull() PingOne.PingOneSDKCallback callback)
Establishes trust with the PingOne server according to a provided geo.
Link copied to clipboard
@Deprecated(since = "2.0.0")
public static String generateMobilePayload(Context context)
public static void generateMobilePayload(Context context, PingOne.PingOneGenerateMobilePayloadCallback callback)
Generates a payload string for any communication needed between the customer mobile app and the PingOne server.
Link copied to clipboard
public static void getInfo(Context context, PingOne.PingOneGetInfoCallback callback)
Get info.
Link copied to clipboard
public static void getOneTimePassCode(Context context, PingOne.PingOneOneTimePasscodeCallback callback)
Requests the SDK to provide One Time Passcode.
Link copied to clipboard
public static void migrateFromPingID(Context context, PingOne.PingOneMigrationStatusCallback callback)
Method that will trigger the migration process, pairing the existing PingID SDK users to the PingOne SDK platform.
Link copied to clipboard
@Deprecated()
public static void pair(Context context, String pairingKey, PingOne.PingOneSDKCallback callback)
Pairs the device with the PingOne server using the pairing key
public static void pair(Context context, String pairingKey, PingOne.PingOneSDKPairingCallback callback)
Pairs the device with the PingOne server using the pairing key.
Link copied to clipboard
public static void processIdToken(String idToken, PingOne.PingOnePairingObjectCallback callback)
Processes ID Token retrieved from the PingOne server.
Link copied to clipboard
@Deprecated()
public static void processRemoteNotification(RemoteMessage remoteMessage, PingOne.PingOneNotificationCallback callback)
Processes the remote notification received from PingOne
public static void processRemoteNotification(Context context, RemoteMessage remoteMessage, PingOne.PingOneNotificationCallback callback)
Processes the FCM remote notification received from the PingOne server.
public static void processRemoteNotification(Context context, String messageData, PingOne.PingOneNotificationCallback callback)
Process the HMS remote notification received from the PingOne server.
Link copied to clipboard
public static void removePingOneLocalData(@NonNull() Context context)
Remove PingOne local data.
Link copied to clipboard
public static void sendLogs(Context context, PingOne.PingOneSendLogsCallback callback)
Send logs to PingOne server.
Link copied to clipboard
public static void setDeviceToken(Context context, String registrationIdToken, NotificationProvider notificationProvider, PingOne.PingOneSetDeviceTokenCallback callback)
Sets device remote notification token.
Link copied to clipboard
public static void setGooglePlayIntegrityProjectNumber(Context context, String projectNumber)
Method that stores a Google Cloud project number to encrypted storage to use when calling Play Integrity APIs.
Link copied to clipboard
@Deprecated()
public static void setSafetyNetApiKey(Context context, String apiKey)
Method that stores a SafetyNet API key to encrypted storage to use in future device integrity validations.
Link copied to clipboard
public static void testRemoteNotification(Context context, PingOneGeo geo, PingOne.PingOneTestRemoteNotificationCallback callback)
Method that tests the push notification flow for a specified paired geography.